ltecat13nax.h File Reference

This file contains API for LTE Cat.1 3 NAX Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures
struct	ltecat13nax_t
	LTE Cat.1 3 NAX Click context object. More...
struct	ltecat13nax_cfg_t
	LTE Cat.1 3 NAX Click configuration object. More...

Macros
#define	LTECAT13NAX_MAX9860_REG_INTR_STATS   0x00
	LTE Cat.1 3 NAX MAX9860 registers.
#define	LTECAT13NAX_MAX9860_REG_MIC_NG_AGC   0x01
#define	LTECAT13NAX_MAX9860_REG_INTR_EN   0x02
#define	LTECAT13NAX_MAX9860_REG_SYS_CLK   0x03
#define	LTECAT13NAX_MAX9860_REG_STEREO_CLK_MSB   0x04
#define	LTECAT13NAX_MAX9860_REG_STEREO_CLK_LSB   0x05
#define	LTECAT13NAX_MAX9860_REG_AUDIO_INTERFACE_1   0x06
#define	LTECAT13NAX_MAX9860_REG_AUDIO_INTERFACE_2   0x07
#define	LTECAT13NAX_MAX9860_REG_VOICE_FILTER   0x08
#define	LTECAT13NAX_MAX9860_REG_DAC_ATTENUATION   0x09
#define	LTECAT13NAX_MAX9860_REG_ADC_OUTPUT_LEVELS   0x0A
#define	LTECAT13NAX_MAX9860_REG_DAC_GAIN   0x0B
#define	LTECAT13NAX_MAX9860_REG_MIC_GAIN   0x0C
#define	LTECAT13NAX_MAX9860_REG_MIC_AGC   0x0E
#define	LTECAT13NAX_MAX9860_REG_NOISE_GATE   0x0F
#define	LTECAT13NAX_MAX9860_REG_SYS_SHUTDOWN   0x10
#define	LTECAT13NAX_CMD_AT   "AT"
	LTE Cat.1 3 NAX control commands.
#define	LTECAT13NAX_CMD_ATI   "ATI"
#define	LTECAT13NAX_CMD_CFUN   "AT+CFUN"
#define	LTECAT13NAX_CMD_CREG   "AT+CREG"
#define	LTECAT13NAX_CMD_CGDCONT   "AT+CGDCONT"
#define	LTECAT13NAX_CMD_CSQ   "AT+CSQ"
#define	LTECAT13NAX_CMD_COPS   "AT+COPS"
#define	LTECAT13NAX_CMD_CMGS   "AT+CMGS"
#define	LTECAT13NAX_CMD_CMGF   "AT+CMGF"
#define	LTECAT13NAX_CMD_CGPADDR   "AT+CGPADDR"
#define	LTECAT13NAX_CMD_QIACT   "AT+QIACT"
#define	LTECAT13NAX_CMD_CHUP   "AT+CHUP"
#define	LTECAT13NAX_CMD_QIRD   "AT+QIRD"
#define	LTECAT13NAX_CMD_QIGETERROR   "AT+QIGETERROR"
#define	LTECAT13NAX_CMD_QICSGP   "AT+QICSGP"
#define	LTECAT13NAX_CMD_QIOPEN   "AT+QIOPEN"
#define	LTECAT13NAX_CMD_QISEND   "AT+QISEND"
#define	LTECAT13NAX_CMD_QICLOSE   "AT+QICLOSE"
#define	LTECAT13NAX_CMD_CLCC   "AT+CLCC"
#define	LTECAT13NAX_CMD_QGPSGNMEA   "AT+QGPSGNMEA"
#define	LTECAT13NAX_CMD_CSCS   "AT+CSCS"
#define	LTECAT13NAX_CMD_QGPS   "AT+QGPS"
#define	LTECAT13NAX_CMD_ATD   "ATD"
#define	LTECAT13NAX_PSCLK_24MHZ   0x20
	LTE Cat.1 3 NAX MAX9860 commands.
#define	LTECAT13NAX_LRCLK_8MHZ_MSB   0x10
#define	LTECAT13NAX_LRCLK_8MHZ_LSB   0x62
#define	LTECAT13NAX_DBCI_FALLING_EDGE   0x20
#define	LTECAT13NAX_HIZ_ENABLE   0x08
#define	LTECAT13NAX_TDM_ENABLE   0x04
#define	LTECAT13NAX_ABCI_FALLING_EDGE   0x20
#define	LTECAT13NAX_ADLY_ENABLE   0x10
#define	LTECAT13NAX_STEREO_ENABLE   0x08
#define	LTECAT13NAX_AVFLT_DISABLE   0x00
#define	LTECAT13NAX_DVFLT_DISABLE   0x00
#define	LTECAT13NAX_DVA_GAIN_0   0x06
#define	LTECAT13NAX_ADC_GAIN_3   0x00
#define	LTECAT13NAX_DAC_GAIN_0   0x00
#define	LTECAT13NAX_DVST_GAIN_0   0x01
#define	LTECAT13NAX_MIC_GAIN_0   0x20
#define	LTECAT13NAX_PGAM_GAIN_0   0x14
#define	LTECAT13NAX_AGCSRC_ENABLE   0x80
#define	LTECAT13NAX_ANTH_DISABLE   0x00
#define	LTECAT13NAX_AGCTH_MINUS_3   0x00
#define	LTECAT13NAX_POWER_ON   0x80
#define	LTECAT13NAX_DAC_ENABLE   0x08
#define	LTECAT13NAX_ADCL_ADCR_ENABLE   0x03
#define	LTECAT13NAX_PIN_STATE_HIGH   0x01
	LTE Cat.1 3 NAX pin state.
#define	LTECAT13NAX_PIN_STATE_LOW   0x00
#define	LTECAT13NAX_RSP_START   "$"
	LTE Cat.1 3 NAX response buffer commands.
#define	LTECAT13NAX_RSP_DELIMITER   ","
#define	LTECAT13NAX_RSP_GPGGA   "$GPGGA"
#define	LTECAT13NAX_GPGGA_ELEMENT_SIZE   15
	LTE Cat.1 3 NAX GPGGA command elements.
#define	LTECAT13NAX_GPGGA_TIME   1
#define	LTECAT13NAX_GPGGA_LATITUDE   2
#define	LTECAT13NAX_GPGGA_LATITUDE_SIDE   3
#define	LTECAT13NAX_GPGGA_LONGITUDE   4
#define	LTECAT13NAX_GPGGA_LONGITUDE_SIDE   5
#define	LTECAT13NAX_GPGGA_QUALITY_INDICATOR   6
#define	LTECAT13NAX_GPGGA_NUMBER_OF_SATELLITES   7
#define	LTECAT13NAX_GPGGA_H_DILUTION_OF_POS   8
#define	LTECAT13NAX_GPGGA_ALTITUDE   9
#define	LTECAT13NAX_GPGGA_ALTITUDE_UNIT   10
#define	LTECAT13NAX_GPGGA_GEOIDAL_SEPARATION   11
#define	LTECAT13NAX_GPGGA_GEOIDAL_SEPARATION_UNIT   12
#define	LTECAT13NAX_GPGGA_TIME_SINCE_LAST_DGPS   13
#define	LTECAT13NAX_GPGGA_DGPS_REFERENCE_STATION_ID   14
#define	LTECAT13NAX_RSP_OK   "OK"
	LTE Cat.1 3 NAX device response for AT commands.
#define	LTECAT13NAX_RSP_ERROR   "ERROR"
#define	LTECAT13NAX_RSP_RDY   "RDY"
#define	LTECAT13NAX_RSP_SEND_OK   "SEND OK"
#define	LTECAT13NAX_PIN_STATE_HIGH   0x01
	LTE Cat.1 3 NAX pin state.
#define	LTECAT13NAX_PIN_STATE_LOW   0x00
#define	LTECAT13NAX_TX_DRV_BUFFER_SIZE   200
	LTE Cat.1 3 NAX driver buffer size.
#define	LTECAT13NAX_RX_DRV_BUFFER_SIZE   300
#define	LTECAT13NAX_ADDRESS   0x10
	LTE Cat.1 3 NAX device address setting.
#define	LTECAT13NAX_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	ltecat13nax_return_value_t {   LTECAT13NAX_OK = 0 , LTECAT13NAX_ERROR = -1 , LTECAT13NAX_ERROR_TIMEOUT = -2 , LTECAT13NAX_ERROR_CMD = -3 ,   LTECAT13NAX_ERROR_UNKNOWN = -4 }
	LTE Cat.1 3 NAX Click return value data. More...

Functions
void	ltecat13nax_cfg_setup (ltecat13nax_cfg_t *cfg)
	LTE Cat.1 3 NAX configuration object setup function.
err_t	ltecat13nax_init (ltecat13nax_t *ctx, ltecat13nax_cfg_t *cfg)
	LTE Cat.1 3 NAX initialization function.
err_t	ltecat13nax_generic_write (ltecat13nax_t *ctx, uint8_t *data_in, uint16_t len)
	LTE Cat.1 3 NAX data writing function.
err_t	ltecat13nax_generic_read (ltecat13nax_t *ctx, uint8_t *data_out, uint16_t len)
	LTE Cat.1 3 NAX data reading function.
void	ltecat13nax_start_up (ltecat13nax_t *ctx)
	LTE Cat.1 3 NAX start up function.
void	ltecat13nax_set_pwr_pin (ltecat13nax_t *ctx, uint8_t pin_state)
	LTE Cat.1 3 NAX set PWR pin function.
void	ltecat13nax_set_rts_pin (ltecat13nax_t *ctx, uint8_t pin_state)
	LTE Cat.1 3 NAX set RST pin function.
uint8_t	ltecat13nax_get_ri_pin (ltecat13nax_t *ctx)
	LTE Cat.1 3 NAX get RI pin function.
uint8_t	ltecat13nax_get_cts_pin (ltecat13nax_t *ctx)
	LTE Cat.1 3 NAX get cts pin function.
err_t	ltecat13nax_write_register (ltecat13nax_t *ctx, uint8_t reg, uint8_t data_in)
	LTE Cat.1 3 NAX MAX9860 writing function.
err_t	ltecat13nax_read_register (ltecat13nax_t *ctx, uint8_t reg, uint8_t *data_out)
	LTE Cat.1 3 NAX MAX9860 reading function.
err_t	ltecat13nax_max9860_cfg (ltecat13nax_t *ctx)
	LTE Cat.1 3 NAX MAX9860 configuration function.
void	ltecat13nax_send_cmd (ltecat13nax_t *ctx, uint8_t *cmd)
	LTE Cat.1 3 NAX send command function.
void	ltecat13nax_send_cmd_with_params (ltecat13nax_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
	LTE Cat.1 3 NAX send command function with parameter.
void	ltecat13nax_send_cmd_check (ltecat13nax_t *ctx, uint8_t *at_cmd_buf)
	LTE Cat.1 3 NAX check the sent command.
void	ltecat13nax_send_cmd_param_check (ltecat13nax_t *ctx, uint8_t *at_cmd_buf)
	LTE Cat.1 3 NAX check the command parameters.
void	ltecat13nax_set_sim_apn (ltecat13nax_t *ctx, uint8_t *sim_apn)
	LTE Cat.1 3 NAX set sim card APN.
void	ltecat13nax_send_sms_text (ltecat13nax_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
	LTE Cat.1 3 NAX send SMS in text mode.
err_t	ltecat13nax_send_sms_pdu (ltecat13nax_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
	LTE Cat.1 3 NAX send SMS in PDU mode.
err_t	ltecat13nax_parse_gpgga (char *rsp_buf, uint8_t gpgga_element, char *element_data)
	LTE Cat.1 parse GPGGA function.

Detailed Description

This file contains API for LTE Cat.1 3 NAX Click Driver.

Enumeration Type Documentation

ltecat13nax_return_value_t

enum ltecat13nax_return_value_t

LTE Cat.1 3 NAX Click return value data.

Predefined enum values for driver return values.

Enumerator
LTECAT13NAX_OK
LTECAT13NAX_ERROR
LTECAT13NAX_ERROR_TIMEOUT
LTECAT13NAX_ERROR_CMD
LTECAT13NAX_ERROR_UNKNOWN